org.eclipse.vtp.framework.interactions.core.commands
Class MetaDataRequestCommand

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand
      org.eclipse.vtp.framework.interactions.core.commands.MetaDataRequestCommand

All Implemented Interfaces:

ICommand

public final class MetaDataRequestCommand
extends ConversationCommand

A command that requests meta-data from the user.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

INPUT_TYPE_CUSTOM, INPUT_TYPE_FILE, OUTPUT_TYPE_FILE, OUTPUT_TYPE_TEXT

Constructor Summary

MetaDataRequestCommand()
Creates a new MetaDataMessageCommand.

Method Summary

boolean	addMetaDataName(java.lang.String name) Adds a meta-data item to the interaction.
java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String	getDataName() Returns the name of the parameter to pass the provided data as.
java.lang.String	getFilledResultValue() Returns the value of the result parameter to pass if the input is valid.
java.lang.String[]	getMetaDataNames() Returns the names of the meta-data in the interaction.
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the interaction.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the process resumes.
java.lang.String	getResultName() Returns the name of the parameter to pass the result of the request as.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
boolean	removeMetaDataName(java.lang.String name) Removes a meta-data item from the interaction.
void	setDataName(java.lang.String inputName) Sets the name of the parameter to pass the provided data as.
void	setFilledResultValue(java.lang.String filledResultValue) Sets the value of the result parameter to pass if the input is valid.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setResultName(java.lang.String resultName) Sets the name of the parameter to pass the result of the request as.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaDataRequestCommand

public MetaDataRequestCommand()

Creates a new MetaDataMessageCommand.

Method Detail

getDataName

public java.lang.String getDataName()

Returns the name of the parameter to pass the provided data as.

Returns:

The name of the parameter to pass the provided data as.

setDataName

public void setDataName(java.lang.String inputName)

Sets the name of the parameter to pass the provided data as.

Parameters:

inputName - The name of the parameter to pass the provided data as.

getResultName

public java.lang.String getResultName()

Returns the name of the parameter to pass the result of the request as.

Returns:

The name of the parameter to pass the result of the request as.

setResultName

public void setResultName(java.lang.String resultName)

Sets the name of the parameter to pass the result of the request as.

Parameters:

resultName - The name of the parameter to pass the result of the request as.

getFilledResultValue

public java.lang.String getFilledResultValue()

Returns the value of the result parameter to pass if the input is valid.

Returns:

The value of the result parameter to pass if the input is valid.

setFilledResultValue

public void setFilledResultValue(java.lang.String filledResultValue)

Sets the value of the result parameter to pass if the input is valid.

Parameters:

filledResultValue - The value of the result parameter to pass if the input is valid.

getMetaDataNames

public java.lang.String[] getMetaDataNames()

Returns the names of the meta-data in the interaction.

Returns:

The names of the meta-data in the interaction.

addMetaDataName

public boolean addMetaDataName(java.lang.String name)

Adds a meta-data item to the interaction.

Parameters:

name - The name of the meta-data item to add.

removeMetaDataName

public boolean removeMetaDataName(java.lang.String name)

Removes a meta-data item from the interaction.

Parameters:

name - The name of the meta-data item to remove.

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the interaction.

Returns:

The names of the parameters that will be returned from the interaction.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.